<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>include/shark/LinAlg/CachedMatrix.h Source File</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d0c4981f10d03078bcfd5c74fe41ce8.html">shark</a></li><li class="navelem"><a class="el" href="dir_dd3f668d951792dcec83cb1f625ad30c.html">LinAlg</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">CachedMatrix.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_cached_matrix_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">//===========================================================================</span><span class="comment"></span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">/*!</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * </span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * \brief       Efficient quadratic matrix cache</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * </span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * </span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> * \par</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> * </span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> * </span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * \author      T. Glasmachers</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * \date        2007-2012</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> *</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> *</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * \par Copyright 1995-2017 Shark Development Team</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * </span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> * &lt;BR&gt;&lt;HR&gt;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> * This file is part of Shark.</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment"> * &lt;https://shark-ml.github.io/Shark/&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment"> * </span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment"> * Shark is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment"> * it under the terms of the GNU Lesser General Public License as published </span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment"> * by the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment"> * (at your option) any later version.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"> * </span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment"> * Shark is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * GNU Lesser General Public License for more details.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * </span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * along with Shark.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> *</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> */</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment">//===========================================================================</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="preprocessor">#ifndef SHARK_LINALG_CACHEDMATRIX_H</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="preprocessor">#define SHARK_LINALG_CACHEDMATRIX_H</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="preprocessor">#include &lt;<a class="code" href="_dataset_8h.html">shark/Data/Dataset.h</a>&gt;</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="preprocessor">#include &lt;<a class="code" href="_base_8h.html">shark/LinAlg/Base.h</a>&gt;</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="preprocessor">#include &lt;<a class="code" href="_l_r_u_cache_8h.html">shark/LinAlg/LRUCache.h</a>&gt;</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="preprocessor">#include &lt;cmath&gt;</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceshark.html" title="AbstractMultiObjectiveOptimizer.">shark</a> {</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"></span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment">///</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment">/// \brief Efficient quadratic matrix cache</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment">///</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment">/// The access operations of the CachedMatrix class</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment">/// are specially tuned towards the iterative solution</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment">/// of quadratic programs resulting in sparse solutions.</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment">///</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">/// The kernel cache is probably one of the most intricate</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment">/// or mind-twisting parts of Shark. In order to fully understand</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">/// it, reading the source code is essential and this description</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment">/// naturally not sufficient. However, the general ideas are as</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment">/// follows:</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment">///</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment">/// A CachedMatrix owns a pointer to a regular (non-cached)</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">/// kernel matrix, the exact type of which is a template</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">/// parameter. Through it, the actions of requesting an entry</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">/// and propagating column-/row-flips are carried out. Even</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">/// though a CachedMatrix offers some methods also offered</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">/// by the general KernelMatrix, note that it does not inherit</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">/// from it in order to offer greater flexibility.</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">///</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment">/// The CachedMatrix defines a struct tCacheEntry, which</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment">/// represents one row of varying length of a stored kernel matrix.</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">/// The structure aggregates a pointer to the kernel values (stored</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">/// as values of type CacheType); the number of stored values; and</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">/// the indices of the next older and newer cache entries. The latter</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">/// two indices pertain to the fact that the CachedMatrix maintains</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">/// two different &quot;orders&quot; of the examples: one related to location</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">/// in memory, and the other related to last usage time, see below.</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">/// During the lifetime of a CachedMatrix, it will hold a vector of</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">/// the length of the number of examples of tCacheEntry: one entry</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">/// for each example. When an example has no kernel values in the cache,</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">/// its tCacheEntry.length will be 0, its tCacheEntry.data will be NULL,</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">/// and its older and newer variables will be SHARK_CACHEDMATRIX_NULL_REFERENCE.</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment">/// Otherwise, the entries take their corresponding meaningful values.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">/// In particular for tCacheEntry.data, memory is dynamically allocated</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">/// via malloc, reallocated via realloc, and freed via free as fit.</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">///</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment">/// A basic operation the CachedMatrix must support is throwing away</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment">/// old stored values to make room for new values, because it is very</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">/// common that not all values fit into memory (otherwise, consider the</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">/// PrecomputedMatrix class). When a new row is requested via row(..),</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">/// but no room to store it, row(..) has two options for making space:</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">///</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">/// First option: first, the row method checks if the member index</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">/// m_truncationColumnIndex is lower than the overall number of examples.</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment">/// If so, it goes through all existing rows and shortens them to a length</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment">/// of m_truncationColumnIndex. Through this shortening, memory becomes</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">/// available. In other words, m_truncationColumnIndex can be used to</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment">/// indicate to the CachedMatrix that every row longer than</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">/// m_truncationColumnIndex can be clipped at the end. By default,</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment">/// m_truncationColumnIndex is equal to the number of examples and not</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment">/// changed by the CachedMatrix, so no clipping will occur if the</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">/// CachedMatrix is left to its own devices. However, m_truncationColumnIndex</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">/// can be set from externally via setTruncationIndex(..) [this might be</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">/// done after a shrinking event, for example]. Now imagine a situation</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">/// where the cache is full, and the possibility exists to free some</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">/// memory by truncating longer cache rows to length m_truncationColumnIndex.</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment">/// As soon as enough rows have been clipped for a new row to fit in, the</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment">/// CachedMatrix computes the new row and passes back control. Most likely,</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">/// the next time a new, uncached row is requested, more rows will have to</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment">/// get clipped. In order not to start checking if rows can be clipped from</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">/// the very first row over again, the member variable m_truncationRowIndex</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">/// internally stores where the chopping-procedure left off the last time.</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">/// When a new row is requested and it&#39;s time to clear out old entries, it</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">/// will start looking for choppable rows at this index to save time. In</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">/// general, any chopping would happen via cacheResize(..) internally.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">///</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">/// Second option: if all rows have been chopped of at the end, or if this</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">/// has never been an option (due to all rows being shorter or equal to</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment">/// m_truncationColumnIndex anyways), entire rows will get discarded as</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment">/// the second option. This will probably be the more common case. In</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment">/// general, row deletions will happen via cacheDelete(..) internally.</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment">/// The CachedMatrix itself only resorts to a very simple heuristic in</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment">/// order to determine which rows to throw away to make room for new ones.</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment">/// Namely, the CachedMatrix keeps track of the &quot;age&quot; or &quot;oldness&quot; of all</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment">/// cached rows. This happens via the so-to-speak factually doubly-linked</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">/// list of indices in the tCacheEntry.older/newer entries, plus two class</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment">/// members m_cacheNewest and m_cacheOldest, which point to the beginning</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment">/// and end of this list. When row(..) wants to delete a cached row, it</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment">/// always does so on the row with index m_cacheOldest, and this index is</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment">/// then set to the next oldest row. Likewise, whenever a new row is requested,</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment">/// m_cacheNewest is set to point to that one. In order to allow for smarter</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment">/// heuristics, external classes may intervene with the deletion order via</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment">/// the methods cacheRedeclareOldest and cacheRedeclareNewest, which move</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment">/// an example to be deleted next or as late as possible, respectively.</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">///</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment">/// Two more drastic possibilites to influence the cache behaviour are</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment">/// cacheRowResize and cacheRowRelease, which both directly resize (e.g.,</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment">/// chop off) cached row values or even discard the row altogether.</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment">/// In general however, it is preferred that the external application</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment">/// only indicate preferences for deletion, because it will usually not</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment">/// have information on the fullness of the cache (although this functionality</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment">/// could easily be added).</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">///</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"></span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Matrix&gt;</div>
<div class="foldopen" id="foldopen00157" data-start="{" data-end="};">
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html">  157</a></span><span class="keyword">class </span><a class="code hl_class" href="classshark_1_1_cached_matrix.html" title="Efficient quadratic matrix cache.">CachedMatrix</a></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>{</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#acaaab3847ddd106bbcfda358609011a6">  160</a></span>    <span class="keyword">typedef</span> <span class="keyword">typename</span> Matrix::QpFloatType <a class="code hl_typedef" href="classshark_1_1_cached_matrix.html#acaaab3847ddd106bbcfda358609011a6">QpFloatType</a>;</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"></span> </div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment">    /// Constructor</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment">    /// \param base       Matrix to cache</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment">    /// \param cachesize  Main memory to use as a kernel cache, in QpFloatTypes. Default is 256MB if QpFloatType is float, 512 if double.</span></div>
<div class="foldopen" id="foldopen00165" data-start="{" data-end="}">
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#acbf86b7470e20b4176d2ec56c6be2c8a">  165</a></span><span class="comment"></span>    <a class="code hl_function" href="classshark_1_1_cached_matrix.html#acbf86b7470e20b4176d2ec56c6be2c8a">CachedMatrix</a>(Matrix* base, std::size_t cachesize = 0x4000000)</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>    : <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#aec2edea13ec507ae67076d98cdfd687d" title="matrix to be cached">mep_baseMatrix</a>(base), <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>( base-&gt;<a class="code hl_function" href="classshark_1_1_cached_matrix.html#aff0ff1f338d99ff3030a321cd292140f" title="return the size of the quadratic matrix">size</a>(),cachesize ){}</div>
</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span>        <span class="comment"></span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment">    /// \brief Copies the range [start,end) of the k-th row of the matrix in external storage</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment">    ///</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment">    /// This call regards the access to the line as out-of-order, thus the cache is not influenced.</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment">    /// \param k the index of the row</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment">    /// \param start the index of the first element in the range</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment">    /// \param end the index of the last element in the range</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment">    /// \param storage the external storage. must be big enough capable to hold the range</span></div>
<div class="foldopen" id="foldopen00175" data-start="{" data-end="}">
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#a09afc06315ddf58b64497d67886cb805">  175</a></span><span class="comment"></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classshark_1_1_cached_matrix.html#a09afc06315ddf58b64497d67886cb805" title="Copies the range [start,end) of the k-th row of the matrix in external storage.">row</a>(std::size_t k, std::size_t start,std::size_t end, <a class="code hl_typedef" href="classshark_1_1_cached_matrix.html#acaaab3847ddd106bbcfda358609011a6">QpFloatType</a>* storage)<span class="keyword"> const</span>{</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span>        <a class="code hl_define" href="_exception_8h.html#a42a6a50e4d06c00d60fbca5333f40768">SIZE_CHECK</a>(start &lt;= end);</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span>        <a class="code hl_define" href="_exception_8h.html#a42a6a50e4d06c00d60fbca5333f40768">SIZE_CHECK</a>(end &lt;= <a class="code hl_function" href="classshark_1_1_cached_matrix.html#aff0ff1f338d99ff3030a321cd292140f" title="return the size of the quadratic matrix">size</a>());</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span>        std::size_t cached= <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#ad8cae64a351bdef5e03976d1e5176072" title="Returns the size of the cached line.">lineLength</a>(k);</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span>        <span class="keywordflow">if</span> ( start &lt; cached)<span class="comment">//copy already available data into the temporary storage</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span>        {</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span>            <a class="code hl_typedef" href="classshark_1_1_cached_matrix.html#acaaab3847ddd106bbcfda358609011a6">QpFloatType</a> <span class="keyword">const</span>* line = <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#a2848536687dec954b5ec1cea247866eb" title="Just returns the pointer to the i-th line without affcting cache at all.">getLinePointer</a>(k);</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span>            std::copy(line + start, line+cached, storage);</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span>        }</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span>        <span class="comment">//evaluate the remaining entries</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span>        <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#aec2edea13ec507ae67076d98cdfd687d" title="matrix to be cached">mep_baseMatrix</a>-&gt;row(k,cached,end,storage+(cached-start));</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span>    }</div>
</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"></span> </div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment">    /// \brief Return a subset of a matrix row</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment">    ///</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment">    /// \par</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment">    /// This method returns an array of QpFloatType with at least</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment">    /// the entries in the interval [begin, end[ filled in.</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment">    ///</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment">    /// \param k      matrix row</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment">    /// \param start  first column to be filled in</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment">    /// \param end    last column to be filled in +1</span></div>
<div class="foldopen" id="foldopen00197" data-start="{" data-end="}">
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#a5bbb64e31e0b33409f9fe76b939d735e">  197</a></span><span class="comment"></span>    <a class="code hl_typedef" href="classshark_1_1_cached_matrix.html#acaaab3847ddd106bbcfda358609011a6">QpFloatType</a>* <a class="code hl_function" href="classshark_1_1_cached_matrix.html#a5bbb64e31e0b33409f9fe76b939d735e" title="Return a subset of a matrix row.">row</a>(std::size_t k, std::size_t start, std::size_t end){</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span>        (void)start;<span class="comment">//unused</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span>        <span class="comment">//Save amount of entries already cached</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span>        std::size_t cached= <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#ad8cae64a351bdef5e03976d1e5176072" title="Returns the size of the cached line.">lineLength</a>(k);</div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span>        <span class="comment">//create or extend cache line</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span>        <a class="code hl_typedef" href="classshark_1_1_cached_matrix.html#acaaab3847ddd106bbcfda358609011a6">QpFloatType</a>* line = <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#a1d1d221a9216657a86b799233d80c1af" title="Returns the line with index i with the correct size.">getCacheLine</a>(k,end);</div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span>        <span class="keywordflow">if</span> (end &gt; cached)<span class="comment">//compute entries not already cached</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span>            <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#aec2edea13ec507ae67076d98cdfd687d" title="matrix to be cached">mep_baseMatrix</a>-&gt;row(k,cached,end,line+cached);</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span>        <span class="keywordflow">return</span> line;</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span>    }</div>
</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment"></span> </div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment">    /// return a single matrix entry</span></div>
<div class="foldopen" id="foldopen00209" data-start="{" data-end="}">
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#acc663e94e28d7e35fd77b2c8b4889c07">  209</a></span><span class="comment"></span>    <a class="code hl_typedef" href="classshark_1_1_cached_matrix.html#acaaab3847ddd106bbcfda358609011a6">QpFloatType</a> <a class="code hl_function" href="classshark_1_1_cached_matrix.html#acc663e94e28d7e35fd77b2c8b4889c07" title="return a single matrix entry">operator () </a>(std::size_t i, std::size_t j)<span class="keyword"> const</span>{ </div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span>        <span class="keywordflow">return</span> <a class="code hl_function" href="classshark_1_1_cached_matrix.html#a00453296e3eca46e834420e3d20a6d6f" title="return a single matrix entry">entry</a>(i, j);</div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span>    }</div>
</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"></span> </div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment">    /// return a single matrix entry</span></div>
<div class="foldopen" id="foldopen00214" data-start="{" data-end="}">
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#a00453296e3eca46e834420e3d20a6d6f">  214</a></span><span class="comment"></span>    <a class="code hl_typedef" href="classshark_1_1_cached_matrix.html#acaaab3847ddd106bbcfda358609011a6">QpFloatType</a> <a class="code hl_function" href="classshark_1_1_cached_matrix.html#a00453296e3eca46e834420e3d20a6d6f" title="return a single matrix entry">entry</a>(std::size_t i, std::size_t j)<span class="keyword"> const</span>{</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span>        <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#aec2edea13ec507ae67076d98cdfd687d" title="matrix to be cached">mep_baseMatrix</a>-&gt;entry(i, j);</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span>    }</div>
</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"></span> </div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment">    ///</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment">    /// \brief Swap the rows i and j and the columns i and j</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment">    ///</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment">    /// \par</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment">    /// It may be advantageous for caching to reorganize</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment">    /// the column order. In order to keep symmetric matrices</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment">    /// symmetric the rows are swapped, too. This corresponds</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment">    /// to swapping the corresponding variables.</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment">    ///</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment">    /// \param  i  first row/column index</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment">    /// \param  j  second row/column index</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment">    ///</span></div>
<div class="foldopen" id="foldopen00230" data-start="{" data-end="}">
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#aad2529155a7ebf9ef3de0cacf46956d0">  230</a></span><span class="comment"></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classshark_1_1_cached_matrix.html#aad2529155a7ebf9ef3de0cacf46956d0" title="Swap the rows i and j and the columns i and j.">flipColumnsAndRows</a>(std::size_t i, std::size_t j)</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span>    {</div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span>        <span class="keywordflow">if</span>(i == j)</div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span>            <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span>        <span class="keywordflow">if</span> (i &gt; j)</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span>            std::swap(i,j);</div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span> </div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span>        <span class="comment">// exchange all cache row entries</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span>        <span class="keywordflow">for</span> (std::size_t  k = 0; k &lt; <a class="code hl_function" href="classshark_1_1_cached_matrix.html#aff0ff1f338d99ff3030a321cd292140f" title="return the size of the quadratic matrix">size</a>(); k++)</div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span>        {</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span>            std::size_t length = <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#ad8cae64a351bdef5e03976d1e5176072" title="Returns the size of the cached line.">lineLength</a>(k);</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span>            <span class="keywordflow">if</span>(length &lt;= i) <span class="keywordflow">continue</span>;</div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span>            <a class="code hl_typedef" href="classshark_1_1_cached_matrix.html#acaaab3847ddd106bbcfda358609011a6">QpFloatType</a>* line = <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#a2848536687dec954b5ec1cea247866eb" title="Just returns the pointer to the i-th line without affcting cache at all.">getLinePointer</a>(k);<span class="comment">//do not affect caching</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span>            <span class="keywordflow">if</span> (j &lt; length)</div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span>                std::swap(line[i], line[j]);</div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span>            <span class="keywordflow">else</span> <span class="comment">// only one element is available from the cache</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span>                line[i] = <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#aec2edea13ec507ae67076d98cdfd687d" title="matrix to be cached">mep_baseMatrix</a>-&gt;entry(k, j);</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span>        }</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span>        <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#af995657d3a4cd3c7c85550e0fb056985" title="swaps index of lines i and j.">swapLineIndices</a>(i,j);</div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span>        <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#aec2edea13ec507ae67076d98cdfd687d" title="matrix to be cached">mep_baseMatrix</a>-&gt;flipColumnsAndRows(i, j);</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span>    }</div>
</div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment"></span> </div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">    /// return the size of the quadratic matrix</span></div>
<div class="foldopen" id="foldopen00253" data-start="{" data-end="}">
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#aff0ff1f338d99ff3030a321cd292140f">  253</a></span><span class="comment"></span>    std::size_t <a class="code hl_function" href="classshark_1_1_cached_matrix.html#aff0ff1f338d99ff3030a321cd292140f" title="return the size of the quadratic matrix">size</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="keyword">    </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#aec2edea13ec507ae67076d98cdfd687d" title="matrix to be cached">mep_baseMatrix</a>-&gt;size(); }</div>
</div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment"></span> </div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">    /// return the size of the kernel cache (in &quot;number of QpFloatType-s&quot;)</span></div>
<div class="foldopen" id="foldopen00257" data-start="{" data-end="}">
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#a4e3b71aa789c0cb4036f4bbf76313f9a">  257</a></span><span class="comment"></span>    std::size_t <a class="code hl_function" href="classshark_1_1_cached_matrix.html#a4e3b71aa789c0cb4036f4bbf76313f9a" title="return the size of the kernel cache (in &quot;number of QpFloatType-s&quot;)">getMaxCacheSize</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="keyword">    </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#a54c4f8d27361379cc684a5f3bd0ad2c5">maxSize</a>(); }</div>
</div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment"></span> </div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">    /// get currently used size of kernel cache (in &quot;number of QpFloatType-s&quot;)</span></div>
<div class="foldopen" id="foldopen00261" data-start="{" data-end="}">
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#a53c29c87d1c481a928abf63171d45fbd">  261</a></span><span class="comment"></span>    std::size_t <a class="code hl_function" href="classshark_1_1_cached_matrix.html#a53c29c87d1c481a928abf63171d45fbd" title="get currently used size of kernel cache (in &quot;number of QpFloatType-s&quot;)">getCacheSize</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="keyword">    </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#ae089a1943125f1be80d521caaefdfd0e">size</a>(); }</div>
</div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment"></span> </div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">    /// get length of one specific currently cached row</span></div>
<div class="foldopen" id="foldopen00265" data-start="{" data-end="}">
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#a752febb4f36dd418bce1e8eeefbc549a">  265</a></span><span class="comment"></span>    std::size_t <a class="code hl_function" href="classshark_1_1_cached_matrix.html#a752febb4f36dd418bce1e8eeefbc549a" title="get length of one specific currently cached row">getCacheRowSize</a>(std::size_t k)<span class="keyword"> const</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="keyword">    </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#ad8cae64a351bdef5e03976d1e5176072" title="Returns the size of the cached line.">lineLength</a>(k); }</div>
</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span>    </div>
<div class="foldopen" id="foldopen00268" data-start="{" data-end="}">
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#a64a43716271f03ac6415a5cecc4c1e5d">  268</a></span>    <span class="keywordtype">bool</span> <a class="code hl_function" href="classshark_1_1_cached_matrix.html#a64a43716271f03ac6415a5cecc4c1e5d">isCached</a>(std::size_t k)<span class="keyword"> const</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="keyword">    </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#aa7fe0128f8b11bfab3e6e89d0544b4dd" title="Returns true if the line is cached.">isCached</a>(k); }</div>
</div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span>    <span class="comment"></span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">    ///\brief Restrict the cached part of the matrix to the upper left nxn sub-matrix</span></div>
<div class="foldopen" id="foldopen00272" data-start="{" data-end="}">
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#af653442cee95203259116e1f4605ca35">  272</a></span><span class="comment"></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classshark_1_1_cached_matrix.html#af653442cee95203259116e1f4605ca35" title="Restrict the cached part of the matrix to the upper left nxn sub-matrix.">setMaxCachedIndex</a>(std::size_t n){</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span>        <a class="code hl_define" href="_exception_8h.html#a42a6a50e4d06c00d60fbca5333f40768">SIZE_CHECK</a>(n &lt;=<a class="code hl_function" href="classshark_1_1_cached_matrix.html#aff0ff1f338d99ff3030a321cd292140f" title="return the size of the quadratic matrix">size</a>());</div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span>        </div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span>        <span class="comment">//truncate lines which are too long</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span>        <span class="comment">//~ m_cache.restrictLineSize(n);//todo: we can do that better, only resize if the memory is actually needed</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span>        <span class="comment">//~ for(std::size_t i = 0; i != n; ++i){</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span>            <span class="comment">//~ if(m_cache.lineLength(i) &gt; n)</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span>                <span class="comment">//~ m_cache.resizeLine(i,n);</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span>        <span class="comment">//~ }</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span>        <span class="keywordflow">for</span>(std::size_t i = n; i != <a class="code hl_function" href="classshark_1_1_cached_matrix.html#aff0ff1f338d99ff3030a321cd292140f" title="return the size of the quadratic matrix">size</a>(); ++i){<span class="comment">//mark the lines for deletion which are not needed anymore</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span>            <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#a738129f952a28aa14f35c952079d0a7e" title="Marks cache line i for deletion, that is the next time memory is needed, this line will be freed.">markLineForDeletion</a>(i);</div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span>        }</div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span>    }</div>
</div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment"></span> </div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment">    /// completely clear/purge the kernel cache</span></div>
<div class="foldopen" id="foldopen00287" data-start="{" data-end="}">
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#ae000f8c2a306080058593b6ade36db12">  287</a></span><span class="comment"></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classshark_1_1_cached_matrix.html#ae000f8c2a306080058593b6ade36db12" title="completely clear/purge the kernel cache">clear</a>()</div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span>    { <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>.<a class="code hl_function" href="classshark_1_1_l_r_u_cache.html#afd6ed6c3442f200616f4c7d4cee32144" title="empty cache">clear</a>(); }</div>
</div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span> </div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#aec2edea13ec507ae67076d98cdfd687d">  291</a></span>    Matrix* <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#aec2edea13ec507ae67076d98cdfd687d" title="matrix to be cached">mep_baseMatrix</a>; <span class="comment">///&lt; matrix to be cached</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span> </div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno"><a class="line" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8">  293</a></span>    <a class="code hl_class" href="classshark_1_1_l_r_u_cache.html" title="Implements an LRU-Caching Strategy for arbitrary Cache-Lines.">LRUCache&lt;QpFloatType&gt;</a> <a class="code hl_variable" href="classshark_1_1_cached_matrix.html#a8beb8003d800373adbea3036690f85d8" title="cache of the matrix lines">m_cache</a>; <span class="comment">///&lt; cache of the matrix lines</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span>};</div>
</div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span> </div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span>}</div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div>
</body>
</html>
